FoxitPDFSDKPython2.AccessibilityProviderCallback Class Reference

Inherits FoxitPDFSDKPython2._object.

Public Member Functions
def	DrawLine (pdf_doc, page_index, type, line_info_array)
	A callback function used to draw lines for accessibility visualization. More...
def	DrawRect (pdf_doc, page_index, type, rect_info_array)
	A callback function used to draw rectangles for accessibility visualization. More...
def	DrawText (pdf_doc, page_index, type, text_info_array)
	A callback function used to draw text for accessibility visualization. More...
def	GenerateContent (pdf_doc, page_index)
	A callback function used to generate content for a specified page. More...
def	GetDocumentFileName (pdf_doc)
	A callback function used to get the document file name. More...
def	GetTextStringByStringID (string_id)
	A callback function used to get text string by string ID. More...
def	OnContentChanged (pdf_doc, page_index, is_notify_self)
	A callback function used to notify that content has changed on a specified page. More...
def	Release ()
	A callback function used to release current callback object itself. More...

Static Public Attributes
	e_DrawRectTypeContent = _fsdk.AccessibilityProviderCallback_e_DrawRectTypeContent
	Draw rect type : content.
	e_DrawRectTypeLabel = _fsdk.AccessibilityProviderCallback_e_DrawRectTypeLabel
	Draw rect type : label.
	e_DrawRectTypeLine = _fsdk.AccessibilityProviderCallback_e_DrawRectTypeLine
	Draw rect type : line.
	e_DrawRectTypeOrderRect = _fsdk.AccessibilityProviderCallback_e_DrawRectTypeOrderRect
	Draw rect type : order rect.
	e_DrawRectTypeTableCell = _fsdk.AccessibilityProviderCallback_e_DrawRectTypeTableCell
	Draw rect type : table cell.
	e_DrawRectTypeTableCellsBorder = _fsdk.AccessibilityProviderCallback_e_DrawRectTypeTableCellsBorder
	Draw rect type : table cells border.
	e_DrawRectTypeTableCellsDataBackground = _fsdk.AccessibilityProviderCallback_e_DrawRectTypeTableCellsDataBackground
	Draw rect type : table cells data background.
	e_DrawRectTypeTableCellsDataBackgroundMissingHeader = _fsdk.AccessibilityProviderCallback_e_DrawRectTypeTableCellsDataBackgroundMissingHeader
	Draw rect type : table cells data background missing header.
	e_DrawRectTypeTableCellsDataBackgroundMultispan = _fsdk.AccessibilityProviderCallback_e_DrawRectTypeTableCellsDataBackgroundMultispan
	Draw rect type : table cells data background multispan.
	e_DrawRectTypeTableCellsHeaderBackground = _fsdk.AccessibilityProviderCallback_e_DrawRectTypeTableCellsHeaderBackground
	Draw rect type : table cells header background.
	e_DrawRectTypeTableCellsHeaderBackgroundMissingHeader = _fsdk.AccessibilityProviderCallback_e_DrawRectTypeTableCellsHeaderBackgroundMissingHeader
	Draw rect type : table cells header background missing header.
	e_DrawRectTypeTableCellsHeaderBackgroundMultispan = _fsdk.AccessibilityProviderCallback_e_DrawRectTypeTableCellsHeaderBackgroundMultispan
	Draw rect type : table cells header background multispan.
	e_DrawRectTypeTableCellsSelectedBorder = _fsdk.AccessibilityProviderCallback_e_DrawRectTypeTableCellsSelectedBorder
	Draw rect type : table cells selected border.
	e_DrawRectTypeTableCellsType = _fsdk.AccessibilityProviderCallback_e_DrawRectTypeTableCellsType
	Draw rect type : table cells type.
	e_DrawRectTypeTableFigure = _fsdk.AccessibilityProviderCallback_e_DrawRectTypeTableFigure
	Draw rect type : table figure.
	e_DrawRectTypeTableLabel = _fsdk.AccessibilityProviderCallback_e_DrawRectTypeTableLabel
	Draw rect type : table label.
	e_DrawRectTypeText = _fsdk.AccessibilityProviderCallback_e_DrawRectTypeText
	Draw rect type : text.

Detailed Description

This class represents a render provider for accessibility, used to generate content and draw visual elements.

All the pure virtual functions in this class are used as callback functions and should be implemented by user in derived class. The render provider is shared between the accessibility classes and ReadingOrderEditor, providing rendering capabilities for accessibility visual feedback.

Member Function Documentation

DrawLine()

def FoxitPDFSDKPython2.AccessibilityProviderCallback.DrawLine	(		pdf_doc,
			page_index,
			type,
			line_info_array
	)

A callback function used to draw lines for accessibility visualization.

Parameters

[in]	pdf_doc	The PDF document object.
[in]	page_index	The page index.
[in]	type	The draw rect type. Please refer to values starting from FoxitPDFSDKPython2.AccessibilityProviderCallback.e_DrawRectTypeContent and this should be one of these values..
[in]	line_info_array	The array of accessibility line info objects.

Returns

None.

DrawRect()

def FoxitPDFSDKPython2.AccessibilityProviderCallback.DrawRect	(		pdf_doc,
			page_index,
			type,
			rect_info_array
	)

A callback function used to draw rectangles for accessibility visualization.

Parameters

[in]	pdf_doc	The PDF document object.
[in]	page_index	The page index.
[in]	type	The draw rect type. Please refer to values starting from FoxitPDFSDKPython2.AccessibilityProviderCallback.e_DrawRectTypeContent and this should be one of these values..
[in]	rect_info_array	The array of accessibility rect info objects.

Returns

None.

DrawText()

def FoxitPDFSDKPython2.AccessibilityProviderCallback.DrawText	(		pdf_doc,
			page_index,
			type,
			text_info_array
	)

A callback function used to draw text for accessibility visualization.

Parameters

[in]	pdf_doc	The PDF document object.
[in]	page_index	The page index.
[in]	type	The draw rect type. Please refer to values starting from FoxitPDFSDKPython2.AccessibilityProviderCallback.e_DrawRectTypeContent and this should be one of these values..
[in]	text_info_array	The array of accessibility text info objects.

Returns

None.

GenerateContent()

def FoxitPDFSDKPython2.AccessibilityProviderCallback.GenerateContent	(		pdf_doc,
			page_index
	)

A callback function used to generate content for a specified page.

Parameters

[in]	pdf_doc	The PDF document object.
[in]	page_index	The page index.

Returns

true means content generated successfully, while false means not.

GetDocumentFileName()

def FoxitPDFSDKPython2.AccessibilityProviderCallback.GetDocumentFileName

(

pdf_doc

)

A callback function used to get the document file name.

Parameters

[in]

pdf_doc

The PDF document object.

Returns

The document file name.

GetTextStringByStringID()

def FoxitPDFSDKPython2.AccessibilityProviderCallback.GetTextStringByStringID

(

string_id

)

A callback function used to get text string by string ID.

Parameters

[in]

string_id

The string ID.

Returns

The text string.

OnContentChanged()

def FoxitPDFSDKPython2.AccessibilityProviderCallback.OnContentChanged	(		pdf_doc,
			page_index,
			is_notify_self
	)

A callback function used to notify that content has changed on a specified page.

Parameters

[in]	pdf_doc	The PDF document object.
[in]	page_index	The page index.
[in]	is_notify_self	Whether to notify self.

Returns

None.

Release()

def FoxitPDFSDKPython2.AccessibilityProviderCallback.Release

(

)

A callback function used to release current callback object itself.

Returns

None.